Docs For Class Email

Email

Description

Klasse zum Versenden von Emails mit dem eStudy-Portal.

Diese Klasse stellt eine Reihe von Funktionalitäten bereit die im Umgang mit Emails hilfreich sein können.
Der gesammte Emailverkehr des eStudy-Prtals soll mit Hilfe dieser Klasse zentralisiert, um eine geringe Kopplung unter den einzelnen eStudy-Komponenten zu erreichen und die mehrfach Generierung von Code zu verhindern
Die beiden Methoden validate() und sendMessageToAddressFromNotUser() können entsprechend auch ohne das zugehörige Objekt benutzt werden.

author: Christian Gerhardt <case42@gmx.net>
version: 0.1.3, 04/04/04
copyright: 2003

Located in /common/classes/class.email.inc.php (line 50)

Variable Summary

string $contentType

string $email

string $name

integer $userID

Method Summary

static bool send (array $data)

static bool sendMessageToAddressFromNotUser (string $subject, string $from, mixed $to, string $message, [bool $single = false])

static bool sendSecure (array $data)

static bool validate (string $address)

Email Email (integer $userID)

string getSignature ()

string getUserEmailAddress (integer $userID)

bool sendMessageToAddress (string $subject, mixed $to, string $message, [bool $single = false])

bool sendMessageToUser (string $subject, mixed $to, string $message, [bool $single = false])

bool sendSecureMessageToUser (string $subject, mixed $to, string $message)

void sendSignature (bool $how)

void setContentType ( $how)

Variables

string $contentType (line 57)

In welchem Format die Email abgeschickt werden soll.

Gültig sind html und txt.

access: protected

string $email (line 69)

Die Emailadresse des Benutzers.

access: protected

string $name (line 75)

Der Name des Benutzers.

access: protected

integer $userID (line 63)

Die ID des aktuellen Benutzers .

access: protected

Methods

static send (line 295)

Versendet Emails.

Diese Methode stellt die flexibelsten Weg dar und es gibt eigentlich keinen Grund warum man die in PHP bereits eingebaute mail() Funktion nicht dieser vorziehen sollte. Der einzige Grund ist die Zentralisierung und die dadurch erreichte Entkoppeltung zwischen den einzelnen Elementen. Jedewede Versendung von Emails soll über diese Klasse gehen und dem entsprechend muß es diese Methode geben, um die Möglichkeiten der mail() Funktion abzubilden.
Die Datenstruktur als Parameter sieht folgenermaßen aus:
$data['to'] - Empfängeradresse
$data['subject'] - Betreff
$data['message'] - Die Nachricht
$data['from'] - Die Absender-adresse (Wird in den Header eingbaut) $data['header'] - Der Header der übergeben werden soll.

return: - Erfolgswert
access: public

bool send (array $data)

array $data
:
- Eine Datenstruktur für die Daten der E-Mail

static sendMessageToAddressFromNotUser (line 204)

Sendet eine Nachticht von einem Nicht-Portalbenutzer an eine externe Adresse.

Auch mehere Empfänger sind möglich. Wenn $single = TRUE wird an jeden User eine einzelne Email versendet, falls FALSE wird eine Sammelmail an alle versendet.

return: - Erfolgswert
access: public

bool sendMessageToAddressFromNotUser (string $subject, string $from, mixed $to, string $message, [bool $single = false])

string $from
:
- Absenderadresse
string $subject
:
- der Betreff
mixed $to
:
- eine Empfängeradresse(string) oder mehrere (array)
string $message
:
- die Nachricht
bool $single
:
- ob an jeden User eine einzelne Mail versendet werden soll, oder eine Sammelmail an alle gleichzeitig

static sendSecure (line 418)

Versendet verschlüsselt und signierte Emails.

Die Datenstruktur als Parameter sieht folgenermaßen aus:
$data['to'] - Empfängeradresse
$data['subject'] - Betreff
$data['message'] - Die Nachricht
$data['from'] - Die Absender-adresse (Wird in den Header eingbaut) $data['header'] - Der Header der übergeben werden soll.

return: - Erfolgswert
author: Tobias Wolf <tobias.wolf@mni.fh-giessen.de>
version: 1.0, 30/07/08
access: public

bool sendSecure (array $data)

array $data
:
- Eine Datenstruktur für die Daten der E-Mail

static validate (line 240)

Überprüft E-Mail-Adressen auf Richtigkeit.

Übergebene E-Mail-Adresse wird auf Übereinstimmung mit dem in der RFC819-Spezifikation beschriebenen Aufbau einer Internet-Mailbox-Adresse überprüft.

return: - true, falls Adresse richtigen Aufbau hat; false, falls nicht.
author: Timo Fuchs <timo.fuchs@mni.fh-giessen.de>
version: 1.0, 09/11/03
access: public

bool validate (string $address)

string $address
:
- Die zu überprüfende E-Mail-Adresse.

Constructor Email (line 100)

Kontruktur für Email-Objekte.

Dieser Kontruktor benötigt die ID des aktuellen Users des Portals und holt sich mit deren Hilfe seine Email-Adresse aus der Datenbank.
Sollte bei diesem Vorgang ein Fehler auftreten, wird die userID auf 0 gesetzt und seine Emailadresse bekommt den bool'schen Wert false.
Dies sollte aber bei korrekter Anwendung der Klasse und des Portals nicht vorkommen.

access: public

Email Email (integer $userID)

integer $userID
:
- Die ID des aktuellen Users

getSignature (line 386)

Gibt die Signatur des Portals in einem String zurück

access: public

string getSignature ()

getUserEmailAddress (line 349)

Holt die Emailadresse eines Users aus der Datenbank

return: - die Emailadresse oder false
access: public

string getUserEmailAddress (integer $userID)

integer $userID
:
- Die ID des Users

sendMessageToAddress (line 170)

Sendet eine Nachricht an eine Externe Adresse.

Auch mehrer Empfänger sind möglich. Wenn $single = TRUE wird an jeden User eine einzelne Email versendet, falls FALSE wird eine Sammelmail an alle versendet.

return: - Erfolgswert
access: public

bool sendMessageToAddress (string $subject, mixed $to, string $message, [bool $single = false])

string $subject
:
- der Betreff
mixed $to
:
- eine Empfängeradresse(string) oder mehrere (array)
string $message
:
- Die Nachricht
bool $single
:
- ob an jeden User eine einzelne Mail versendet werden soll, oder eine Sammelmail an alle gleichzeitig

sendMessageToUser (line 125)

Sendet eine Nachricht an einen User oder mehrere User des Portals.

Wenn $single = TRUE wird an jeden User eine einzelne Email versendet, falls FALSE wird eine Sammelmail an alle versendet.

return: - Erfolgswert
access: public

bool sendMessageToUser (string $subject, mixed $to, string $message, [bool $single = false])

string $subject
:
- der Betreff
mixed $to
:
- ein Empfänger-UserID(integer) oder mehrere (array aus integern)
string $message
:
- die Nachricht
bool $single
:
- ob an jeden User eine einzelne Mail versendet werden soll, oder eine Sammelmail an alle gleichzeitig

sendSecureMessageToUser (line 459)

Sendet verschlüsselt und signierte Nachrichten an einen User oder mehrere User des Portals.

return: - Erfolgswert
author: Tobias Wolf <tobias.wolf@mni.fh-giessen.de>
version: 1.0, 30/07/08
access: public

bool sendSecureMessageToUser (string $subject, mixed $to, string $message)

string $subject
:
- der Betreff
mixed $to
:
- ein Empfänger-UserID(integer)
string $message
:
- die Nachricht

sendSignature (line 368)

Stellt ein ob an eine Email die Signatur des Portals angehängt werden soll.

access: public

void sendSignature (bool $how)

bool $how: - Ob die Signature gesendet werden soll(=true) oder nicht(=false).

setContentType (line 377)

Setzt das Format der Email auf einen neuen Typ.

var: - txt oder html
access: public

void setContentType ( $how)

$how

Documentation generated on Sat, 07 Nov 2009 00:28:54 +0100 by phpDocumentor 1.4.3